home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1996 #15 / Monster Media Number 15 (Monster Media)(July 1996).ISO / spitfire / sfq10.zip / SFQ.DOC < prev    next >
Text File  |  1996-04-06  |  11KB  |  238 lines
  1.  
  2.  
  3.                                                               
  4.  
  5.       ------------------------------------------
  6.       ░▓█▓░  SFQ v1.0 Shareware  
  7.       ░▓█▓░  Copyright(c) 1996 by Eldon Martin
  8.       ------------------------------------------
  9.             
  10.         SFQ is a questionaire door for  use with Spitfire.  It is designed
  11.       to  be  closely  compatible  with  the  file  formats  supported  by
  12.       Spitfire's internal questionaire processor.  SFQ is also capable  of
  13.       Q&A styles that are impossible with Spitfire.
  14.       
  15.         SFQ is supplied  "as  is".   The  author disclaims all warranties,
  16.       expressed or implied, including, without limitation, the  warranties
  17.       of  merchantability  and  of  fitness  for  any purpose.  The author
  18.       assumes no liability for damages, direct or consequential, which may
  19.       result from the use of  SFQ.   By  the  use of this program, you are
  20.       expressing your agreement to the above disclaimer of warranty.
  21.       
  22.         SFQ has been tested by  me  on  a single-node BBS without a fossil
  23.       driver.  Any feedback as to how it runs  with  other  configurations
  24.       will  be  greatly  appreciated.   Although I included code to handle
  25.       file locking/sharing as I  thought  it  was necessary, my experience
  26.       with such things is a bit limited.
  27.             
  28.         Here is a list  of  files  that  are  distributed  as part of this
  29.       package:
  30.             
  31.       SFQ.EXE           - The main executable file
  32.       SFQ.DOC           - The program documentation (this file)
  33.       SFQ.INI           - The optional configuration file
  34.       DEMO.BAT          - Provides a quick tour of SFQ
  35.       SAMPLE.QUE        - Sample questionaire file
  36.       REGISTER.TXT      - Registration Form
  37.  
  38.       ------------------
  39.        Shareware Notice
  40.       ------------------      
  41.       
  42.         SFQ is distributed as shareware.  You may use it for an evaluation
  43.       period of 30 days.  After  that,  you  must  either quit using it or
  44.       register  it  by  sending  $10  to  the author.  Please use the form
  45.       contained in the file  REGISTER.TXT,  which  is  included in the SFQ
  46.       package.  If this file is missing, you may simply send your check or
  47.       money order to the address at the bottom of this document.
  48.       
  49.         The unregistered version of SFQ has a short message and  delay  at
  50.       startup.  After  putting  hours  of  time  into  SFQ,  I  felt  this
  51.       measure  was necessary to ensure that nobody would take advantage of
  52.       my work without paying  the  appropiate fee.  The registered version
  53.       of SFQ seamlessly integrates with Spitfire.  NO messages of any kind
  54.       will be displayed to the caller.  
  55.       
  56.  
  57.       ----------------------
  58.        Command Line Options
  59.       ----------------------
  60.             
  61.       The syntax for executing SFQ is as follows:
  62.           
  63.       SFQ inputfile outputfile [dropfile] [/L] [/FD] [/IRQx]
  64.             
  65.        inputfile = Name of SF compatible questionaire file
  66.       outputfile = Name of file  to  write  replies to.  This file will be
  67.                    formatted nearly identicle to a .REP  file  written  by
  68.                    Spitfire.
  69.         dropfile = Name of SFDOORS.DAT  compatible  drop file.  If this is
  70.                    not specified, SFQ will look in the  current  directory
  71.                    for a dropfile.  (SFQ automatically  searches  for  the
  72.                    valid   Spitfire   dropfiles,   such   as   SFFILE.DAT,
  73.                    SFMESS.DAT, etc..)
  74.               /L = puts SFQ in local mode.  When you use this switch,  SFQ
  75.                    will run without reading a drop file.
  76.              /FD = Use this switch if you want SFQ to use a fossil driver.
  77.            /IRQx = This   switch  is  only  needed  if  you  are  using  a
  78.                    non-standard IRQ.  If this switch is not used, SFQ will
  79.                    use  the  default  IRQ  values (COM1 and COM3 use IRQ4,
  80.                    COM2 and COM4 use IRQ3).
  81.              /OT = This switch makes  SFQ  allow each caller to answer the
  82.                    questionaire only once.  When this switch  is  on,  SFQ
  83.                    creates  a  file  called  FILENAME.~~~ (filename is the
  84.                    name of the questionaire  file minus the extension) and
  85.                    writes the  names  of  the  callers  who  complete  the
  86.                    questionaire to this file.  When SFQ starts up the next
  87.                    time,  it  then  searches  for the callers name in this
  88.                    file to see if he/she  is visiting the questionaire for
  89.                    the second time.  This switch should be used only  when
  90.                    needed  -  I imagine if enough people answered SFQ with
  91.                    this option enabled, it  could  result in a brief pause
  92.                    while SFQ searched the list for the caller's name.
  93.             
  94.       
  95.       ---------------------
  96.        General Information
  97.       ---------------------
  98.             
  99.         The SFQ.INI file lets you configure  the way SFQ looks and acts to
  100.       a certain degree.  Load it up in ASCII text editor  (EDIT.COM  works
  101.       well for this) to have a look.  
  102.       
  103.         There are a few features of SFQ which do not work in local mode as
  104.       they  do  when  a remote caller is logged on.  Firstly, SFQ does not
  105.       log off a local user that  runs  out  of time or is inactive for the
  106.       specified length of time.  Also, the ~ command does not log a  local
  107.       user  off  as  it does a remote caller.  When SFQ starts up, it will
  108.       clear the screen on the local end.  The screen is not cleared on the
  109.       caller end unless the ^L display  code  is found in beginning of the
  110.       questionaire file.
  111.       
  112.  
  113.  
  114.                                                               
  115.         SFQ  supports  all  Spitfire  questionaire commands except the $x$
  116.       command which adds x  number  of  days  to the callers subscription.
  117.       Hopefully I will get this feature  added  to  SFQ  sometime  in  the
  118.       near future.
  119.         
  120.         Here is a list of Spitfire display codes that SFQ supports:
  121.             
  122.       ^D  =  Displays caller's first name
  123.       ^L  =  Clears screen
  124.       ^V  =  Displays caller's full name
  125.       ^Y  =  Displays caller's security level
  126.       ^P  =  Exhibits an < ENTER > prompt 
  127.       
  128.         Here is a list of  keys  available  to  the sysop when a caller is
  129.       using SFQ:
  130.             
  131.       Alt+F1 or Alt+F2   = Kick user off
  132.       F6                 = Take 5 Minutes
  133.       F7                 = Give 5 Minutes
  134.                                                                 
  135.             
  136.       ------------------------
  137.        The GetInput() Command
  138.       ------------------------
  139.       
  140.         SFQ includes a powerful command which  allows you to do things not
  141.       possible with Spitfire's internal questionaire processor.  The usage
  142.       format of this command is as follows:
  143.                                   
  144.       !GetInput(PROMPT_GUIDE_MASK_MODE)
  145.       
  146.         The  exclamation  point  indicates to SFQ that the line contains a
  147.       command.  The exclamation point must  be  present; if it is not, SFQ
  148.       will simply display the line  as  text  to  the  caller.   The  four
  149.       parameters  must  be  separated  by  underscores,  and  enclosed  in
  150.       parentheses.
  151.       
  152.         The PROMPT parameter is the question  that  is  displayed  to  the
  153.       caller,  such  as  "What is your first name?" (without the quotation
  154.       marks).
  155.       
  156.         The  GUIDE  is  a  string  of characters which is displayed to the
  157.       caller to show how the input  is  to be typed in.  This parameter is
  158.       purely optional and can be left blank.  The  GUIDE  string  will  be
  159.       displayed  just above the line on which the user types the answer to
  160.       that particular question.
  161.       
  162.         The MASK is a  string  that  is  not  displayed to the caller, but
  163.       governs the way the input field acts.  You can use the  MASK  string
  164.       to  make  SFQ  automatically insert any character at any location in
  165.       the field.  One application of this  is  a question which asks for a
  166.       telephone number, and inserts the "-"s as the user types.  The  MASK
  167.       also  governs  the  allowed  length  of  input.   There are two main
  168.       characters in the MASK:  the  asterisk  (*)  and the pound sign (#).
  169.  
  170.  
  171.                                                               
  172.  
  173.  
  174.                                                               
  175.  
  176.       Putting a "*" in the string makes SFQ  allow  any  character  to  be
  177.       typed at that location of the input field.  A "#" allows only digits
  178.       (0-9) or spaces to be input.  Any other charactar in the MASK string
  179.       will  be  automatically  inserted at that particular location as the
  180.       user types.  The  following  MASK  string  would  be  suitable for a
  181.       telephone number input: ###-###-#### .  It would allow  only  digits
  182.       and  would  automatcally  insert  the "-"s at the correct locations.
  183.       That MASK string could also  be  (###)###-#### or ### ###-#### .  As
  184.       you can see, the possibilities are limitless.  If the MASK  area  is
  185.       left  blank,  SFQ  will  allow anything to be typed, and the allowed
  186.       length of input will be set to  include whatever area is left on the
  187.       line. 
  188.       
  189.         MODE is a number from 0 to 3 and specifies what type of prompt SFQ
  190.       will display.  The prompt types are as follows:
  191.         0 = two-line optional input    (same as Spitfire Q&A format)
  192.         1 = two-line forced input      (same as Spitfire Q&A format)
  193.         2 = one-line optional input  
  194.         3 = one-line forced input  
  195.       
  196.       
  197.       Example:
  198.       
  199.         !GetInput(Enter your ZIP code: ,#####-####,#####-####,4)
  200.       
  201.       The above command results in the following display:
  202.       
  203.                              #####-####
  204.         Enter your ZIP code: _
  205.       
  206.       If MODE were set to  1  or  2  instead  of  4, SFQ would display the
  207.       following:
  208.       
  209.         Enter your ZIP code: 
  210.         #####-####
  211.         _
  212.       
  213.       
  214.       In both cases, SFQ would allow only digits to be  typed,  and  would
  215.       automatically insert the "-"s in the correct positions.
  216.       
  217.         The best way to gain  an  understanding  of the way the GetInput()
  218.       command works to to take a look at the sample .QUE file included  in
  219.       the distribution package.
  220.             
  221.  
  222.  
  223.       -----------------------
  224.         The Data Sector BBS 
  225.       -----------------------
  226.             
  227.         This program was provided to you by the sysop of The  Data  Sector
  228.       BBS.  Call today to make sure you have the latest version of SFQ and
  229.       to  have  a  look at other great utilities for Spitfire sysops.  The
  230.       number is (717) 485 - 5914 and  supports 300 to 14400 baud.  You can
  231.       also reach the author of this program  by  the  snail  mail  address
  232.       below.  Thank you for using SFQ.
  233.             
  234.         Eldon Martin                             BBS: (717) 485-5914
  235.         HCR 75 Box 99                            SFNET Node A0717008
  236.         McConnellsburg, PA 17233
  237.  
  238.